/**
 * Copyright (c) <2010>, <SUNNY GUPTA>
 * All rights reserved.

 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of the <ORGANIZATION> nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <SUNNY GUPTA> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.gwtp.investmentadvisor.server.externaldataservices;

import java.util.Calendar;
import java.util.List;

import com.gwtp.investmentadvisor.server.core.exception.NotSupportedException;
import com.gwtp.investmentadvisor.server.entities.finance.FinancialSecurity;
import com.gwtp.investmentadvisor.server.entities.finance.FinancialSecurityQuote;
import com.gwtp.investmentadvisor.server.externaldataservices.exception.DataServiceException;
import com.gwtp.investmentadvisor.shared.entities.FinancialSecurityView;

/**
 * @author Sunny Gupta
 *
 */
public interface FinancialSecurityDataProvider {

  /**
   * Obtains Current Market Price (Last Traded Price)
   * Note: For Mutual Funds, this will return the last NAV
   * @param financialSecurity
   * @return
   * @throws DataServiceException
   */
  FinancialSecurityQuote getCurrentMarketPrice(FinancialSecurity financialSecurity) throws DataServiceException;
  
  /**
   * Overloaded version of {@link FinancialSecurityDataProvider#getCurrentMarketPrice(FinancialSecurity)}
   * @param financialSecurityView
   * @return
   * @throws DataServiceException
   */
  FinancialSecurityView getCurrentMarketPrice(FinancialSecurityView financialSecurityView) throws DataServiceException;
  
  /**
   * Obtains Historical Quotes using Financial Security Ticker Symbol
   * @param financialSecurity
   * @param startDate
   * @param endDate
   * @param quotePeriod
   * @return
   * @throws DataServiceException
   */
  List<FinancialSecurityQuote> getHistoricalQuotes(FinancialSecurity financialSecurity, Calendar startDate, Calendar endDate, HistoricalQuotePeriod quotePeriod) throws DataServiceException;
  
  /**
   * Text search for Financial Security
   * @param searchText
   * @return
   * @throws DataServiceException
   */
  List<FinancialSecurityView> searchByText(String searchText) throws DataServiceException;
  
  /**
   * Obtains Current Market Price for ALL Financial Securities. This can take a long time, however
   * Note: This may NOT be supported by all implementations. In such case a {@link NotSupportedException} is thrown
   * @return
   * @throws DataServiceException, NotSupportedException
   */
  List<FinancialSecurityQuote> getCurrentMarketPriceForAllFinancialSecurities() throws DataServiceException, NotSupportedException;
}
 